Learning Objectives

After completing this lesson, you’ll be able to:

Resources

Why Document Your Workspaces?

Sven has created a workspace that converts his data from Excel to geodatabase. However, before he finishes working on this workspace, Sven needs to add bookmarks and annotations. Bookmarks and annotations provide documentation for your workspace. If you have any experience programming, documenting your workspace is like commenting your code. These steps ensure that if your primary FME author goes on vacation or leaves the company, documentation will help the next FME author maintain, troubleshoot, and expand your organization's FME workspaces.

Adding Bookmarks

As a first step, Sven will use bookmarks to describe sections of his workspace. Bookmarks help you organize your workspace into logical sections. They make it easier to tell at a glance what each workspace section is doing. They also have some advanced functionality useful when working with large workspaces, such as zooming to a particular bookmark or collapsing bookmarks to reduce visual clutter.

Sven opens FME Workbench (2023.0 or later) and adds two bookmarks to his workspace to surround his reader and writer feature types. He does this by selecting all the feature types he wants to include in a bookmark.

Selecting multiple feature types

Then he clicks on Bookmark in the toolbar.

Adding a Bookmark

Note

Or you can the CTRL key (⌘ or Shift on Mac) + B . View all FME Workbench keyboard shortcuts.

After clicking the button, his feature types are surrounded by the colored bookmark. He can then type in a name. He names the Excel reader feature type bookmark “Public Art” and the writer feature type bookmark “Output.”

Workspace with bookmarks 

Adding Annotations

He also wants to add a note to describe what formats are being read. To do this, he adds an annotation by right-clicking on the BusinessOwners reader feature type and then clicking Attach Annotation or pressing CTRL key (⌘ or Shift on Mac) + K (for "Komment," if you speak German!). He edits it to say: “Excel business licenses spreadsheet.”

Annotating a feature type

This annotation makes it easy to see what data is being read and written. He repeats the process for his other reader feature types, resizing his bookmarks by clicking and dragging their edges as needed.

Documented workspace

Exercise

Make sure you have followed along with Sven’s steps.